Esx Settings Inventory EntitySpec

The Esx Settings Inventory EntitySpec schema contains properties that describe the inventory and its entities on whom operations like extract images, transition will be executed.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "type": "string",
    "hosts": [
        "string"
    ],
    "clusters": [
        "string"
    ],
    "folders": [
        "string"
    ],
    "datacenters": [
        "string"
    ]
}

string

type

Required

The property specifies what type of entity within the vCenter's inventory on which the operation will be executed.

For more information see: Esx Settings Inventory EntitySpec InventoryType.

This property was added in vSphere API 9.0.0.0.

array of string

hosts

Optional

List of hosts on which the specified operation needs to be executed.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Esx Settings Inventory EntitySpec InventoryType.HOST.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string

clusters

Optional

List of clusters on which the specified operation needs to be executed.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Esx Settings Inventory EntitySpec InventoryType.CLUSTER.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.

array of string

folders

Optional

List of folders on which the specified operation will be executed. Internally each folder entity will be expanded to individual hosts and clusters which are underneath the designated folder. If the list contains the managed object ID of the root folder, the specified operation will be executed on all clusters and standalone hosts in the vCenter.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Esx Settings Inventory EntitySpec InventoryType.FOLDER.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

array of string

datacenters

Optional

List of the data-centers on which the specified operation will be executed. Internally each data-center entity will be expanded to individual hosts and clusters which are underneath the designated data-center.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of type is Esx Settings Inventory EntitySpec InventoryType.DATACENTER.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.